Einhugur Word Plugin for Objo

Einhugur.Word.Run Class

The run class represents single styling context within a paragraph. The Run carries the text parts and the styling info.

Einhugur.Word.ParagraphItem
   Einhugur.Word.Run

class Einhugur.Word.Run

Properties

BoldIf set to true then text in the Run has Bold style.
CapsSets or gets the text caps (None, Caps or Smallcaps)
ComplexRunFieldDataReturns extra data for a complex run field.
ComplexRunPartCountReturns number of parts in the current complex run if the run is part of a complex run.
ComplexRunPartTypeReturns the type of the field which the complex run carries if the run is a complex run.
DrawingGets drawing object from the Run.
FieldSeparatorReturns info on if the run is field separator.
FieldSeparatorLockReturns true if the field separator has lock on it.
HasTextColorReturns true if the Run has TextColor on it.
HasUnderlineColorReturns true if Underline in the Run has color on it, else false.
HighlightColorSets or gets the highlight color in the Run.
InstrTextUsed to read special info, mostly for legacy versions of the Word file format. For example then old versions of the file format can store hyperlinks here instead of in hyperlink object.
IsDrawingReturns true if the run object is Drawing, else false.
IsPageBreakReturns true if the run object is a page break, else false.
IsShapeReturns true if the run object is a shape, else false.
ItalicIf set to true then text on the Run has Italic style.
LanguageCodeSets or gets language code for the Run. For example de-DE for Germany, is-IS for Iceland, en-US for English American, etc)
ShapeReturns the shape object of the Run if the Run is a shape, else nil is returned.
SpacingSets or gets character spacing for the Run.
StrikethroughSets or gets strike through style.
StyleSets or gets predefined CharacterStyle for the Run. When reading then nil will be returned no character style has been set.
TabSegmentCountReturns number of Tab segments in the Run.
TextText which the run carries.
TextColorColor for the text on the Run.
UnderlineSets or gets the underline style.
UnderlineColorReturns color of the Underline or black if there is no color or is no underline.
VerticalAlignmentSets or gets vertical alignment which is basically subscript and superscript.

Methods

ApplyFieldDataApplies field data to the given Run only.
ClearTextColorRemoves text color, setting TextColor to none.
ClearUnderlineColorRemoves underline color, setting UnderlineColor to none.
ComplexRunPartReturns Run at given index belonging to a complex Run.
Dispose (Inherited) Releases unmanaged resources used by the ParagraphItem class.
SetUnderlineWithColorSets underline and color for the underline.
TabSegmentTextGets text of a given tab segment.
TabSegmentTextSets text of a given tab segment.

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 64 bit
  • Linux ARM 64 bit